概述
SViewWeb API 为用户介绍了云服务接口的调用方法和详细说明，帮助第三方调用云服务接口。
约定
- 接口名采用骆驼命名法。
- 接口参数及接口返回Json串的键名使用小写字母加下划线格式如："modify_time"，文档中的"mroot"代表云服务根域名。
返回值
| 模块 | 返回值 | 说明 |
|---|---|---|
| 公共参数 | 0 | 成功 |
| 1 | 参数不得为空(参数为空或者参数不存在) | |
| 2 | 参数内容传值错误 | |
| 3 | 文件不存在 | |
| 授权服务 | 2003 | 您的试用申请已达上限 |
| 2004 | 无可用点数 | |
| 2006 | 许可信息不存在 | |
| 2007 | 产品名称不匹配 | |
| 2008 | 主版本号不匹配 | |
| 2009 | 令牌已过期 | |
| 2010 | 授权还没开始 | |
| 2011 | 授权已到期 | |
| 2012 | 无权限 | |
| 2013 | 认证模式不匹配 | |
| 2014 | MAC地址不匹配 | |
| 2015 | 许可文件重复上传 | |
| 2016 | 文件上传失败 | |
| 2017 | 许可不存在 | |
| 2018 | 许可已禁止使用 | |
| 2019 | 您已被禁止访问 | |
| 2020 | 许可认证失败 | |
| 2021 | 许可签名不匹配 | |
| 2022 | 令牌与客户端不匹配 | |
| 2023 | 令牌与认证产品不匹配 | |
| 2024 | 许可申请信息不存在 | |
| 2025 | 邮件发送失败 | |
| 2026 | 产品版本号格式错误 | |
| 2027 | 该产品已存在 | |
| 2028 | 该产品及版本已存在 | |
| 用户模块 | 3001 | 用户名或密码错误 |
| 3002 | 缺少登录凭证 | |
| 3003 | 用户未登录 | |
| 3004 | 用户不存在 | |
| 3005 | 用户名已注册 | |
| 3006 | 原密码错误 | |
| 云盘模块 | 4001 | 文件/夹不存在 |
| 4002 | 上传文件大小超过最大允许大小 | |
| 4003 | 用户空间不足 | |
| 4004 | 引用文件不存在 | |
| 4005 | 请选择需要移动的文件/夹 | |
| 4006 | 不能将文件夹移动到自身目录下 | |
| 4007 | 不能移动到同一个文件夹下,请选择其他文件夹 | |
| 4008 | 不能将文件夹移动到子目录下 | |
| 4009 | 文件/夹名重复，重命名失败 | |
| 4010 | 不能将文件/夹移动到他人目录下 | |
| 4011 | 不能移动别人文件/夹 | |
| 4012 | 不能重命名别人文件/夹 | |
| 4013 | 请选择需要删除的文件/夹 | |
| 4014 | 不能解压别人文件/夹 | |
| 4015 | 解压失败,仅支持.zip,.rar格式 | |
| 4016 | 解压失败 | |
| 4017 | 文件夹名重复，创建失败 | |
| 产品模块 | 5001 | 请选择图片 |
| 5002 | 产品已存在 | |
| 5003 | 产品版本号格式不正确 |
接口列表
| 模块 | 接口 | 说明 | 备注 |
|---|---|---|---|
| 授权模块 | mroot/api/licence/access | 获取访问令牌 | |
| mroot/api/licence/check | 验证许可 | ||
| mroot/api/licence/release | 释放许可 | 仅网络版并发许可类型使用 | |
| mroot/api/licence/info | 获取许可信息 |
获取访问令牌
接口
mroot/api/licence/access
说明
获取访问令牌
参数
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | 许可唯一id,从许可文件中获取 |
| name | 是 | 产品名 |
| version | 是 | 产品版本号 |
| devices | 是 | 客户设备唯一号,deviceid/mac |
| state | 是 | 随机数 |
返回值
正确时的返回:
{
"return":"0",
"token":"649bcd20-a635-488a-8fd7-55647a8a6c6c",
"expires":"3600"//多久后过期,单位秒
}
错误时的返回:
{
"return":"1",//"2006"、"2007"、"..."
"msg":"参数错误!"//或"许可信息不存在!"...
}
备注
无
验证许可
接口
mroot/api/licence/check
说明
验证许可
参数
| 参数 | 是否必须 | 说明 |
|---|---|---|
| token | 是 | 访问令牌,由上一个接口获得 |
| devices | 是 | 客户设备ID或MAC |
| users | 否 | 客户提供的用户ID，如无则传递空字符串"" |
| modules | 否 | 功能编号，各客户端需统一,["openFile","explosive","animation","measure"] |
| state | 是 | 随机数 |
返回值
正确时的返回:
{
"return":"0",
"context":"['app':'1']"//返回值使用state随机数进行加密
}
错误时的返回:
{
"return":"1",//"2009"、"2022"
"msg":"参数错误!"//或"令牌与客户端不匹配!"...
"context":"['app':'0']"//返回值使用state随机数进行加密
}
备注
无
释放许可
接口
mroot/api/licence/release
说明
释放许可
参数
| 参数 | 是否必须 | 说明 |
|---|---|---|
| token | 是 | 访问令牌 |
| type | 是 | 认证模式,0=设备ID/Mac地址认证(devices),1=账户认证（users），服务端要验证此字段。 |
| devices | 是 | 客户设备ID或MAC |
| users | 否 | 客户提供的用户ID，如无则传递空字符串"",type值为1时需要传递此字段 |
| modules | 否 | 功能编号，各客户端需统一,["openFile","explosive","animation","measure"] |
返回值
正确时的返回:
{
"return":"0"
}
错误时的返回:
{
"return":"1",//"2012"
"msg":"参数错误!"...
}
备注
每次浏览模型结束后需要调用此接口释放许可。
获取许可信息
接口
mroot/api/licence/info
说明
获取许可信息
参数
| 参数 | 是否必须 | 说明 |
|---|---|---|
| token | 是 | 访问令牌 |
| names | 是 | 授权信息名,即lic文件中的等号“=”左侧的信息名。如果要获取所有,则使用“all”。如果要获取部分,使用半角逗号来间隔,如“Customer,CustomerEmail” |
| devices | 是 | 客户设备ID或MAC |
| state | 是 | 随机数 |
返回值
正确时的返回:
{
"return":"0",
"context":{
'SView License':'v1.0',
'ID':'201906041404095813844',
'ProductName':'SView for iOS',
'ProductVersion':'6.1',
'LicenseType':'2200',
'Seat':'30',
'ServerMAC':'00-00-00-00-00-00',
'BeginDate':'2019-06-04',
'EndDate':'2019-08-04',
'Customer':'SView',
'CustomerEmail':'123123@163.com',
'Creator':'SView License Tools v1.0',
'CreateDate':'2019-06-04',
'CopyRight':'Shandong Hoteam Software Co.,Ltd',
'SignCode':'c3efe0a941d0e8aa00fgreg8f25ec35787'
}
}
错误时的返回:
{
"return":"1",//"2009"
"msg":"参数错误!"...
}
备注
无